[No QA] Remove default values for IDs to comply with eslint rules #54306

pac-guerreiro · 2024-12-18T16:06:44Z

Explanation of Change

Fixed Issues

$#50360
PROPOSAL:

Remove ?? '-1' and ?? '0' defaults for IDs in src/libs/actions/Report.ts

Tests

N/A

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

melvin-bot · 2024-12-18T16:06:49Z

@paultsimura Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

pac-guerreiro · 2024-12-18T16:08:23Z

cc @VickyStash

VickyStash

Left some comments, will take more thorough look tomorrow! 👀

src/libs/actions/Report.ts

VickyStash · 2024-12-18T16:15:04Z

src/libs/actions/Report.ts

+        // API expects a string, that's why policyID must default to a string
+        // eslint-disable-next-line rulesdir/no-default-id-values
+        parentReportID: currentTask.parentReportID ?? '',


API expects a string

Are you sure? How was it before TS migration? Is it be possible to call this API call without parentReportID or with invalid parentReportID?

@VickyStash I'm not sure what the API expects or how to test it, but currently we send '-1' in case currentTask.parentReportID is undefined

Answered here: #54306 (comment)

VickyStash · 2024-12-18T16:15:13Z

src/libs/actions/Report.ts

+    // API expects a string, that's why policyID must default to a string
+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const searchForRoomToMentionParams: SearchForRoomsToMentionParams = {query: searchInput, policyID: policyID ?? ''};


Same question here

Should it be possible to call this request without a valid policyID?

If yes - can we pass undefined instead of '' string?

If no - add a condition to prevent it

@VickyStash I'm not sure what the API expects or how to test it, but currently we send '-1' in case policyID is undefined

Answered here: #54306 (comment)

paultsimura · 2024-12-18T19:51:01Z

src/ROUTES.ts

-        getRoute: (policyID: string, backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,
+        getRoute: (policyID = '', backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,


I think the initial idea of this ESlint change was to make sure the real values are passed where needed. And the missing data to be correctly handled where the function is being called.

For instance, we shouldn't change these getRoute functions, but throw something when we don't have the policyID when calling WORKSPACE_INITIAL.getRoute().

@iwiznia please correct me if I'm wrong. And what should we do when we don't have a policy ID but need to navigate to this page?

I don't think any of these routes should be used by passing an empty policyID

Yeah, I think it makes more sense to add the condition on level above to make sure WORKSPACE_INITIAL.getRoute(...) not called without policy id. Same for other cases here.
@pac-guerreiro let's try to do it so

@iwiznia @paultsimura @VickyStash

getRoute(...) is mostly used in Navigation.navigate(...) and I'm worried that if we prevent it from running we'll disrupt normal app flow

Can't we just do it like this ROUTES.REPORT_WITH_ID.getRoute(`${report.preexistingReportID}`)?

This way we still navigate the user to the new page but we pass undefined as string

Have you tried to navigate to the page with invalid id? What results do you get

@VickyStash if the id is invalid, the page will show a Not found page but it seems that all reports in Onyx are deleted

VickyStash · 2024-12-19T07:51:39Z

src/libs/actions/Report.ts

    if (shouldDismissModal) {
        Navigation.dismissModalWithReport(report);
    } else {
        Navigation.navigateWithSwitchPolicyID({route: ROUTES.HOME});
-        Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report?.reportID ?? '-1'), actionType);
+        Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(report?.reportID), actionType);


Make sure it's not called if there is no report?.reportID

@VickyStash

But if I prevent navigation from happening it will disrupt normal user flow 🤔 Shouldn't we warn the user that there was some problem, or something?

Let's try to test it as I mentioned here. What happens if you navigate user to the screen with -1 id

@VickyStash if the id is invalid, the page will show a Not found page but it seems that all reports in Onyx are deleted

src/libs/actions/Report.ts

VickyStash · 2024-12-19T07:56:07Z

src/libs/actions/Report.ts

+        // API expects a string, that's why parentReportID must default to a string
+        // eslint-disable-next-line rulesdir/no-default-id-values
+        parentReportID: currentTask.parentReportID ?? '',


Should it be possible to call this request without a valid parentReportID?

If yes - can we pass undefined instead of '' string?

If no - add a condition to prevent it

@VickyStash

I don't know that information, where can I get it?

Ideas:

try to call the API call with '', -1 and with undefined as parentReportID - check if it makes any difference

check if the defaulting value always was there

VickyStash · 2024-12-19T07:56:58Z

src/libs/actions/Report.ts

+    // API expects a string, that's why policyID must default to a string
+    // eslint-disable-next-line rulesdir/no-default-id-values
+    const searchForRoomToMentionParams: SearchForRoomsToMentionParams = {query: searchInput, policyID: policyID ?? ''};


Should it be possible to call this request without a valid policyID?

If yes - can we pass undefined instead of '' string?

If no - add a condition to prevent it

…on-report-actions # Conflicts: # src/libs/actions/Report.ts

…on-report-actions

pac-guerreiro · 2024-12-19T23:22:41Z

I applied most of the suggestions but left some questions 😄

VickyStash · 2024-12-20T08:11:33Z

@pac-guerreiro left suggestions to some of your questions!

…on-report-actions

pac-guerreiro · 2024-12-20T20:41:03Z

Today I resolved the remaining eslint issues 😄

@VickyStash I left some replies but I wasn't able to confirm what the API expects in some situations. I guess it should be face to pass undefined for those ids.

I'll be away until January 2nd but someone should take care of my work 😄 Happy holidays! 🎉

fix: undo default values to comply with eslint rules

0612e06

pac-guerreiro requested a review from a team as a code owner December 18, 2024 16:06

melvin-bot bot requested a review from paultsimura December 18, 2024 16:06

melvin-bot bot removed the request for review from a team December 18, 2024 16:06

doc: fix typo in comment

f927a37

VickyStash reviewed Dec 18, 2024

View reviewed changes

paultsimura reviewed Dec 18, 2024

View reviewed changes

VickyStash reviewed Dec 19, 2024

View reviewed changes

VickyStash mentioned this pull request Dec 19, 2024

Fix cycle dependencies in metro console #53852

Open

50 tasks

pac-guerreiro changed the title ~~fix: undo default values to comply with eslint rules~~ [No QA] Remove default values for IDs to comply with eslint rules Dec 19, 2024

pac-guerreiro added 3 commits December 19, 2024 20:54

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

8d1cf91

…on-report-actions # Conflicts: # src/libs/actions/Report.ts

chore: apply suggestions and follow guidelines

7f97310

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

430a195

…on-report-actions

pac-guerreiro mentioned this pull request Dec 19, 2024

[HOLD for payment 2024-12-30] [$250] Undo defaults of -1 and "-1" for account/report/policy IDs #50360

Open

pac-guerreiro added 2 commits December 20, 2024 18:30

Merge branch 'main' into pac-guerreiro/fix/50360-undo-default-values-…

2e07d76

…on-report-actions

chore: resolve eslint issues

4be070e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Remove default values for IDs to comply with eslint rules #54306

[No QA] Remove default values for IDs to comply with eslint rules #54306

pac-guerreiro commented Dec 18, 2024 •

edited

Loading

melvin-bot bot commented Dec 18, 2024

pac-guerreiro commented Dec 18, 2024

VickyStash left a comment

VickyStash Dec 18, 2024

pac-guerreiro Dec 19, 2024

VickyStash Dec 20, 2024

VickyStash Dec 18, 2024

VickyStash Dec 19, 2024

pac-guerreiro Dec 19, 2024

VickyStash Dec 20, 2024

paultsimura Dec 18, 2024

iwiznia Dec 18, 2024

VickyStash Dec 19, 2024

pac-guerreiro Dec 19, 2024

pac-guerreiro Dec 19, 2024

VickyStash Dec 20, 2024

pac-guerreiro Dec 20, 2024

VickyStash Dec 19, 2024

pac-guerreiro Dec 19, 2024

VickyStash Dec 20, 2024

pac-guerreiro Dec 20, 2024

VickyStash Dec 19, 2024

pac-guerreiro Dec 19, 2024

VickyStash Dec 20, 2024 •

edited

Loading

VickyStash Dec 19, 2024

pac-guerreiro commented Dec 19, 2024

VickyStash commented Dec 20, 2024

pac-guerreiro commented Dec 20, 2024

		getRoute: (policyID: string, backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,
		getRoute: (policyID = '', backTo?: string) => `${getUrlWithBackToParam(`settings/workspaces/${policyID}`, backTo)}` as const,

[No QA] Remove default values for IDs to comply with eslint rules #54306

Are you sure you want to change the base?

[No QA] Remove default values for IDs to comply with eslint rules #54306

Conversation

pac-guerreiro commented Dec 18, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 18, 2024

pac-guerreiro commented Dec 18, 2024

VickyStash left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VickyStash Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pac-guerreiro commented Dec 19, 2024

VickyStash commented Dec 20, 2024

pac-guerreiro commented Dec 20, 2024

pac-guerreiro commented Dec 18, 2024 •

edited

Loading

VickyStash Dec 20, 2024 •

edited

Loading